Assign Consentless Lead to Channel

Assign Consentless Lead to Channel assigns an OVOC channel to a lead or customer for voice traffic routing configuration. The operation supports multiple identifier types and automatically determines the appropriate assignment strategy based on the request parameters.

■

Only service provider administrators and system administrators can modify channel assignments

■

Leads must be in "Active" status to be eligible for channel assignment

■

Channel assignment is rate-limited to 300 API calls per minute globally to prevent system overload.

■

The user performing this action must have the appropriate OVOC Service Provider or System user with Admin or Operator security level.

■

Rate limiting is applied globally across all users (300 calls per minute) to protect OVOC system resources

■

OVOC configuration and connectivity are validated before processing assignment requests

URI

Copy

{{baseUrl}}/api/v3/ovoc/channel/action/assign

HTTP Method

PUT

Request Body

Specify one of the following values:

■

leadMsTenantId

■

leadId

■

umpCustomerGuid

Parameter	Type	Description
leadMsTenantId	string (maximum 150 characters)	Microsoft Azure Tenant subscription Id of the customer lead.

Example Request for Lead Assignment by LeadMsTenantId

Copy

 {
  "leadMsTenantId": "a1a1f1aa-e7c1-4ffc-81e3-7b98e119324a",
  "ChannelId": "1315936"
  }

Example Request for Lead Assignment by LeadId

Copy

{
  "leadId": "LEAD-2024-001",
  "channelId": 15
}

Example Request for Customer Assignment

Copy

{
  "umpCustomerGuid": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
  "channelId": 15
}

Example Response

Copy

{
    "status": "success",
    "succeeded": true,
    "message": "Lead successfully assigned to the channel"
}

HTTP Responses

■

200 OK

Parameter

Type

Description

status

One of the following values:

■

Success

■

Failed

succeeded

boolean

■

True: Channel lead is successfully assigned

■

False. Channel lead is not assigned

Indicates if the lead has been successfully assigned to a channel.

message

string

Information message for the action.

■

400 Bad Request:

■

The following error is displayed when the lead already exists in the Live Platform database.

Copy

{
    "errors": {
        "TenantId": [
            "This MsTenant already exists as an UMP lead!"
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-7e087ecc069b2bb6b8edb9b675a1a744-a65210e22368ff22-00"
}

■

The following error is displayed when the Channel Id is not specified in the Request Body.

Copy

{
  "errors": {
    "channelId": ["ChannelId is required and must be greater than 0."]
  },
  "title": "Validation failed",
  "status": 400,
  "instance": "/api/v3/ovoc/channel/action/assign"
}

■

403 Forbidden

■

500 Server Error:

●

The following error is displayed when the Microsoft Tenant is not active.

Copy

{
    "title": "MsTenant 'f889d778-d028-49e0-8056-b5d24abb7ca7' is not active.",
    "status": 500,
    "detail": "ErrorTicket=349d1b99-d688-4a4a-a9da-bdbcb10fffbe"
}

●

The following error is displayed when an incorrect tenant Id is entered or when the customer has already been created for the tenant.

Copy

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
    "title": "Failed to assign channel: ",
    "status": 500,
    "detail": "Lead not found.",
    "traceId": "00-4775720d3a1bae96f4cb21a7cb22ba80-90afde65fe7ba490-00"
}